Customize supported ID documents

Customize settings for countries and documents.

Take full control of your verification process by customizing the Dashboard's acceptance settings for specific countries and documents.

Specify documents for all countries

To specify ID documents for all countries:

  1. In the Dashboard, go to the Supported ID Documents page.
  2. In the table header, select the relevant checkboxes to include the documents to the list of supported.

The changes are saved automatically.

Specify documents for selected countries

To specify ID documents for particular countries:

  1. In the Dashboard, go to the Supported ID Documents page.
  2. Expand a continent with the countries for which you want to customize data extraction.
  3. In the column of the relevant document, click the selector switch and select an option:
    1. Off — document is not allowed.
    2. One Side — document is supported; the front side is required.
    3. Two Sides — document is supported; both front and back sides are required.
    4. Any Sides — document is supported; any side of the document can be provided. This option is available only if any side of country documents contains required data.

The changes are saved automatically.

Customize extraction process

To customize data extraction process:

  1. In the Dashboard, go to the Supported ID Documents page or ID document settings in specific Verification Levels.
  2. Expand a continent with the countries for which you want to customize data extraction.
  3. Hover the cursor over the country you need and click the pencil icon on the right to open the Fields management window.
  4. In the Document field, select the document to be changed.
  5. If Sumsub supports digital version of the selected document type, you will see the Allow digital versions of documents checkbox. Select it, if you want to enable this setting. Note that digital documents generally lack physical security features, which makes them easier to forge compared to physical documents.
  6. Select the Accept document screenshots for POI checkbox if you want to disable screenshot protection. If selected, we will accept screenshots of identity documents for which you have applied this setting.
  7. Uncheck the Details ought to be blurred checkbox if you have a legal obligation or permission to operate with non-blurred documents of the selected type. By default, we blur document data for the following countries: Japan (only My Number Card is blurred), Netherlands, South Korea, and Singapore so that the personal data is protected upon initial recognition. Note that masking already applied cannot be reverted, meaning that, when a document image is partially blurred, it cannot be restored to its original condition. If you uncheck this setting, data extraction will be enabled for new applicants only.
  8. Select expiration check mode:
    1. Strict — accepts only valid documents. Any regulations extending the validity period of a document will not be taken into account.
    2. Generally Accepted Regulations — accepts expired documents if their validity period was extended by a government regulation or decree, for example, documents extended because of COVID.
    3. Local Regulations — accepts expired documents if their usage is allowed by local regulations. For example, in Brazil, it is allowed to accept expired driving licenses as proof of identity.
    4. Allow expired — accepts expired documents.
  9. In the Mode block, select OCR mode, where the Default option stands for accepting all official documents, while MRZ document determines accepting only those that include MRZ.
  10. Choose preferred characters for recognition.
  11. Configure the forbidden document subtypes that contain human-readable names. Note that these names are only available in English. Document subtypes are also displayed on the applicant page, making it easier to understand which document was submitted.
  12. Select the default fields in documents to be recognized and add extra fields for recognition. Mind that you cannot select or deselect mandatory fields.
  13. Click Apply to save your changes.

Data extraction customization is available at an additional cost. Contact our sales team or reach out to your Customer Success Manager for more information.

Adjust ID document subtypes

Our system displays document types on the Identity document verification step. Many identity document types have country-specific subtypes, which are detected automatically during verification based on the recognized document.

For certain document subtypes, we group similar documents under a single, user-friendly name. This helps applicants better understand which document they are expected to upload and simplifies the document selection process in the WebSDK interface.

Click here to expand a list of grouped document subtypes by country. Each group shows the document type, technical subtype codes, and the display name shown to applicants.

Country

Document type

Subtype display name

Subtype code

Argentina (ARG)

Passport

Passport

arg.passport.type1

ID

National Identity Document (DNI)

  • arg.id.type1
  • arg.id.type2
  • arg.id.type3

Driving License

Driver's license

  • arg.drvlic.type1
  • arg.drvlic.type2

Brazil (BRA)

ID

ID Card (RG)

  • bra.id.type1
  • bra.id.type2
  • bra.id.type3
  • bra.id.type4
  • bra.id.type5

Professional Identity Card

  • bra.id.professional.type1
  • bra.id.professional.type2

India (IND)

ID

Aadhaar card

ind.aadhaar.type1

PAN Card

  • ind.pancard.type1
  • ind.pancard.type2

Voter card

ind.voter_card.type1

Mexico (MEX)

Passport

Passport

  • mex.passport.type3
  • mex.passport.type4

ID

Voter ID / INE ID Card

  • mex.id.type2
  • mex.id.type5

Residence Permit

Residence permit

mex.rp.type1

Myanmar (MMR)

Passport

Passport

mmr.passport.type1

Certificate of Identity

mmr.passport.type2

ID

Overseas Worker Identification Card (OWIC card)

mmr.id.type1

National Identity Card

mmr.id.type2

Pakistan (PAK)

Passport

Passport

pak.passport.type1

ID

Identity Card (CNIC)

  • pak.id.type1
  • pak.id.type3

National Identity Card Overseas Pakistanis (NICOP)

pak.id.type2

Driving License

Driving license

  • pak.drvlic.type1
  • pak.drvlic.type5
  • pak.drvlic.type10
  • pak.drvlic.type11

Philippines (PHL)

Passport

Passport

phl.passport.type2

ID

PhilID / National ID

  • phl.id.type11
  • phl.id.type14

Unified Multi-Purpose ID (UMID)

  • phl.id.type1
  • phl.id.type2
  • phl.id.type12
  • phl.id.type15

TIN ID

  • phl.id.type3
  • phl.id.type13

Postal ID

phl.id.type7

Social Security Card / SSS ID

phl.id.type4

Voter’s ID

phl.id.type8

PhilHealth ID

phl.medcard.type1

South Africa (ZAF)

Passport

Passport

zaf.passport.type1

ID

Identity Card

zaf.id.type1

Green ID booklet

  • zaf.id.type2
  • zaf.id.type3

Driving License

Driving licence

zaf.drvlic.type1

South Korea (KOR)

Passport

Passport

  • kor.passport.type1
  • kor.passport.type3

ID

Identity Card / Resident Registration Card

kor.id.type1

Driving License

Driver’s license

kor.drvlic.type1

Residence Permit

Residence Card / Alien Registration Card

  • kor.rp.type1
  • kor.rp.type3

Ukraine (UKR)

Passport

Internal Passport

ukr.passport.type1

International Passport

ukr.id.type1

Driving License

Driving licence

  • ukr.drvlic.type1
  • ukr.drvlic.type2
  • ukr.drvlic.type4
  • ukr.drvlic.type5

Residence Permit

Residence permit

ukr.rp.type3

Hide document subtypes in WebSDK UI

Set up a configuration to hide the list of document subtypes in the WebSDK interface:

  1. Adjust the settings for a specific verification level or apply them across the entire system:
    1. Go to IntegrationsGlobal settings, navigate to the User verification tab, and open Supported ID Documents.
    2. Go to the verification level settings and navigate to the Configurations tab→ID document settings.
  2. Locate the required country and go to the Field management settings.
  3. Select the document type and navigate to the settings under the Subtypes section.
  4. Select the required option and check the Do not show subtypes in WebSDK box.

📘

Note

Once the settings are applied, only the main document type will be displayed in the interface. However, all document subtypes will still be accepted and processed according to the configuration.

Customize document subtype names

Adjust how document subtype names are displayed to applicants in the WebSDK interface using SDK Translations.

To edit subtype names:

  1. Go to Integrations and navigate to SDK Translations.
  2. Select the required translation file and open the WebSDK 2 tab.
  3. Locate the parent translation key customSubtypes.
  4. Edit subtype names and save the changes.

For document types that do not have subtype grouping from the list above, edit the translations under WebSDK 2documentTypes.

🚧

Important

When updating translations, make sure to apply the changes to all languages used in the WebSDK.

Manage extra document fields for OCR

Specify extra document fields that must be scanned by OCR and then transferred as textual information to the applicant profile:

  1. In the Dashboard, go to the Supported ID Documents page.
  2. Select the countries for which you want to manage the document fields and click Manage documents.
  3. Select the documents to be changed and choose the preferred recognition characters.
  4. Set up the manner of changing the field recognition:
    • Select Fields to show to scan the selected fields.
    • Select Fields to hide to disable the selected fields from OCR.
  5. From the Extra fields list, select the fields you want to manage. Unmarked fields will not be changed.
  6. Click Apply to save the changes.